Skip to main content
POST
/
public
/
v1
/
campaign-service
/
campaigns
/
exclusive-banner
[BETA] Create exclusive banner campaign.
curl --request POST \
  --url https://api.topsort.com/public/v1/campaign-service/campaigns/exclusive-banner \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Bola-Bola Ad campaign",
  "isActive": true,
  "externalCampaignId": "<string>",
  "isAutoTrigger": false,
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "exclusivityPrice": 123,
  "position": 1,
  "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "impressionsThreshold": 123,
  "exclusivityPercentage": 123,
  "bids": [
    {
      "amount": 1,
      "location": "Santiago",
      "target": {
        "id": "p_8983",
        "type": "product"
      },
      "trigger": {
        "type": "<string>",
        "value": {
          "words": [
            "<string>"
          ],
          "matchType": "exact"
        }
      },
      "triggers": [],
      "formatProperties": {
        "bannerAssets": [
          {
            "url": "<string>",
            "contentType": "image/png",
            "dimensions": {
              "width": 1920,
              "height": 1080
            },
            "size": 123,
            "assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
            "content": {},
            "jsonTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "slotId": "<string>",
        "deviceType": "desktop",
        "adFormat": "<string>"
      }
    }
  ],
  "status": "pending",
  "productIds": [
    "<string>"
  ]
}'
{
  "name": "Bola-Bola Ad campaign",
  "isActive": true,
  "externalCampaignId": "<string>",
  "isAutoTrigger": false,
  "marketplaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "exclusivityPrice": 123,
  "bidType": "exclusive",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "chargeType": "DAILY",
  "position": 1,
  "campaignType": "manual",
  "status": "pending",
  "adFormat": "exclusive_banner",
  "vendorId": "<string>",
  "impressionsThreshold": 123,
  "exclusivityPercentage": 123,
  "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

A valid API key generated in Topsort's UI.

Query Parameters

​
vendor_id
string
required

The ID of the vendor.

Minimum length: 1

Body

application/json

The request body for creating an exclusive banner campaign.

​
name
string
required

The name of the campaign.

Minimum length: 1
Examples:

"Bola-Bola Ad campaign"

​
startDate
string<date-time>
required

When should the campaign start. If the start date is in the past, it will be set to the current date.

​
endDate
string<date-time>
required

When should the campaign stop. Must be greater than start date.

​
exclusivityPrice
integer
required

The price to pay daily for the campaign to run.

​
bids
BidCreate · object[]
required

An array of bids for this campaign.

Minimum length: 1
​
isActive
boolean
default:true

Whether the campaign should be activated upon creation.The campaign will start when this is set and the start_date has passed.

​
externalCampaignId
string | null

The external ID of the campaign in the marketplace. Must be unique per marketplace and format combination.

​
isAutoTrigger
boolean
default:false

Whether the campaign is auto-triggered.

​
position
integer
default:1

The rank the ad will have in the auction

Required range: 1 <= x <= 20
​
walletId
string<uuid> | null

The uuid of the wallet to be used with this campaign.

​
impressionsThreshold
integer | null

Impressions allowed for the campaign before it is stopped.

​
exclusivityPercentage
number | null

Percentage of auctions the campaign will be exclusive in.

​
status
enum<string>

For an exclusive banner campaign, its initial review status.

Available options:
approved,
pending,
rejected
​
productIds
string[]

The product IDs to be used in the exclusive banner campaign. When provided, the assets will be associated to the given product IDs.

Maximum length: 200

Response

Successful Response

Model that represents an Exclusive Banner Campaign.

​
name
string
required

The name of the campaign.

Minimum length: 1
Examples:

"Bola-Bola Ad campaign"

​
marketplaceId
string<uuid>
required

The ID of the marketplace.

​
campaignId
string<uuid>
required

The ID of the campaign.

​
exclusivityPrice
integer
required

The price to pay daily for the campaign to run.

​
chargeType
enum<string>
required

How exclusive campaigns are going to be charged, only daily is allowed.

Available options:
DAILY
​
campaignType
enum<string>
required

The bidding method for the campaign.

Available options:
manual,
autobidding,
exclusive
​
adFormat
string
required

The ad format of the campaign. Can be exclusive_banner.

Allowed value: "exclusive_banner"
Examples:

"exclusive_banner"

​
vendorId
string
required

The marketplace's ID of the vendor.

​
walletId
string<uuid>
required

The uuid of the wallet to be used with this campaign.

​
isActive
boolean
default:true

Whether the campaign should be activated upon creation.The campaign will start when this is set and the start_date has passed.

​
externalCampaignId
string | null

The external ID of the campaign in the marketplace.

​
isAutoTrigger
boolean
default:false

Whether the campaign is auto-triggered.

​
startDate
string<date-time>

Date when to start the campaign, specified in RFC 3339, if not set that campaign will start immediately after the campaign creation. Must include the Timezone definition.If the start date is in the past, it will be set to the current date.

​
endDate
string<date-time>

Date when to stop the campaign, specified in RFC 3339, if not set the campaign will never stop. This date must be greater than the start date and must be in the future. Must include the Timezone definition.

​
bidType
string
default:exclusive

The bidding type of the campaign.

Allowed value: "exclusive"
​
createdBy
string<uuid> | null

The ID of the user creating the campaign.

​
position
integer
default:1

The rank the ad will have in the auction

Required range: 1 <= x <= 20
​
status
enum<string>

For an exclusive banner campaign, its initial review status.

Available options:
approved,
pending,
rejected
​
impressionsThreshold
integer | null

Impressions allowed for the campaign before it is stopped.

​
exclusivityPercentage
number | null

Percentage of auctions the campaign will be exclusive in.